home *** CD-ROM | disk | FTP | other *** search
/ Aminet 30 / Aminet 30 (1999)(Schatztruhe)[!][Apr 1999].iso / Aminet / mus / midi / XGTool.lha / doc / XGTool.doc < prev   
Text File  |  1999-01-23  |  14KB  |  335 lines
  1.  
  2.  
  3.      XXXX     XXXXXXXXXXXXXX  TTTTTTTTTTTTTTT                      ll
  4.      X   X   X             X  T     TTT     T                      ll
  5.       XX  XXX   XXXXXXXXXXXX        TTT                            ll
  6.         X      X           X        TTT       OOOOOOO    OOOOOOO   ll
  7.          X    X     XXXXX  X        TTT      O OOOOO O  O OOOOO O  ll
  8.         X      X        X  X        TTT      O O   O O  O O   O O  ll
  9.       XX  XXX   XXXXXXXXX  X        TTT      O O   O O  O O   O O  ll
  10.      X   X   X             X        TTT      O OOOOO O  O OOOOO O  ll
  11.      XXXX     XXXXXXXXXXXXXX       TTTTT      OOOOOOO    OOOOOOO    ll
  12.  
  13.          This is the documentation of XGTool V0.91 for Amiga.
  14.  
  15.  
  16. Introduction
  17. -----------------------------------------------------------------------------
  18.  
  19. I started to write this program because I needed it. After I had bought my
  20. new shiny Yamaha MU10 external tone generator (11 Jan 1997) I needed a
  21. program to control its rich features. After a lot of trying and restarting
  22. from scratch XGTool was born (around the end of 1997).
  23.  
  24.  
  25.  
  26.  
  27. Legal Stuff - License/Warranty/Disclaimer
  28. -----------------------------------------------------------------------------
  29.  
  30. You may not distribute XGTool for profit except by arrangement with the
  31. author.
  32.  
  33. XGTOOL IS PROVIDED ON THE UNDERSTANDING THAT THE USER ACCEPTS ALL
  34. RESPONSIBILITY FOR USE OF THE PROGRAM. THE AUTHOR WILL NOT BE LIABLE FOR ANY
  35. DAMAGES OR LOSS OF DATA INCURRED BY USE OF THE PROGRAM. THE AUTHOR DOES NOT
  36. GUARANTEE THE PROGRAM IS FIT FOR PURPOSE OR PROVIDE ANY OTHER GUARANTEES OF
  37. MERCHANTABILITY.
  38.  
  39.  
  40.  
  41.  
  42. System Requirements
  43. -----------------------------------------------------------------------------
  44.  
  45. The development and testing configuration for XGTool  W A S:
  46. - Kickstart V39.106
  47. - M68EC020
  48. - MUI V3.8
  49. - blueribbon.library V3.7 (19.12.93)
  50. - The program occupies around 1MB memory (including MUI)
  51. - A 640x400 screen is the minimum
  52.  
  53. From December 1998 the situation has changed:
  54. I no longer have an Amiga. XGTool is developed under UAE, the Unix Amiga 
  55. Emulator which I run under Linux. I use
  56. - UAE developer version 0.8.6
  57. - Kickstart 40.068
  58. - M68020
  59. - MUI V3.8
  60. - Lamp_mcc V11.1 (16.3.97)
  61. - blueribbon.library V3.7 (19.12.93)
  62. - Picasso96, 800x600, 256 colors
  63.  
  64. If you succeed running XGTool on other configurations, please tell me!!
  65. (address below) I'm especially interested in Enforcer results (whether XGTool
  66. makes any invalid memory accesses). I don't know how to use Enforcer, so if
  67. an XGTool version with debug information is needed for this, please write me
  68. an e-mail, and I send you one.
  69.  
  70.  
  71.  
  72.  
  73. MIDI output
  74. -----------------------------------------------------------------------------
  75.  
  76. XGTool uses either blueribbon.library or midi.library. It fully
  77. cooperates with Bars&Pipes Professional 2.5b (which is the free version on
  78. CompuServe). You can start XGTool behind Bars&Pipes and work with the two
  79. programs together!!
  80.  
  81. Lately you can download the free Bars&Pipes version from the Internet, too.
  82. The address is:
  83. http://members.theglobe.com/geoarn/
  84. An other place I found is:
  85. http://www.csee.uq.edu.au/~richard/music/bars-and-pipes/index.html
  86.  
  87. Support for midi.library is also implemented.
  88.  
  89. To choose between the two libraries, set the XGTOOLOUT environment variable.
  90. If you have an ENV: assignment, then you can do it by saying in the shell:
  91.  
  92.   setenv XGTOOLOUT MIDI     or    setenv XGTOOLOUT BLUE
  93. If the value is invalid, XGTool will use blueribbon.library by default.
  94.  
  95. Everything is sent as System Exclusive messages. This might change in the
  96. future to controllers, NRPNs, where appropriate. (But some values can only be
  97. set with SysEx-es.)
  98.  
  99.  
  100.  
  101.  
  102. Data Transfer to the Tone Generator
  103. -----------------------------------------------------------------------------
  104.  
  105. You can send out your settings to the tone generator with the buttons in the
  106. bottom left corner of the window. Sending settings is used for example after
  107. loading a new file or after some other program corrupted your settings in
  108. the tone generator. In this case you can refresh the settings in you synth.
  109. The leftmost button sends all settings. Beside it you can find separate
  110. buttons for each major setting group. They are
  111. PARTS = MultiPart settings for all 16 parts
  112. EFF   = Effects settings for all effects
  113. AD    = AD Input settings
  114. DR1   = First drum setup
  115. DR1   = Second drum setup
  116.  
  117. By pressing these latter gadgets you can send out a setting group separately.
  118. This way you can refresh settings selectively in the tone generator by
  119. pressing the desired buttons one after the other.
  120.  
  121. With the XGReset button you can send an XGReset message to your synth
  122. (surprisingly). THIS WILL RESET EVERYTHING TO DEFAULT VALUES IN THE SYNTH!
  123. However, XGTool will not reset its settings. After an XGReset you can restore
  124. your settings by sending them to the synth with the ALL button.
  125.  
  126. To reset the settings in XGTool, too, you have to press the "XGTool" button
  127. in the bottom left corner. This sets all the gadgets in XGTool to their
  128. default values. There is no way to restore the buttons' previous state after
  129. pressing this button!
  130.  
  131.  
  132.  
  133.  
  134. The User Interface
  135. -----------------------------------------------------------------------------
  136.  
  137. The program requires MUI V3.8 or better.
  138.  
  139. The original idea was to imitate the look and feel of XGEdit95, but it would
  140. have required a lot of programming and time, so... You can still discover
  141. ideas stolen from that program.
  142.  
  143. The main adjusting gadget:
  144. ~~~~~~~~~~~~~~~~~~~~~~~~~~
  145. It is a derivation of MUI's numericbutton which is a pop-up slider. The
  146. actual value is written on the slider. If the actual value differs from the
  147. default for that parameter the value is highlighted. (This doesn't work
  148. at the drumnote settings, yet.) As you can see the displayed values are
  149. context sensitive, that is, the reverb time is displayed from 0.3s (second)
  150. to 30s and not from 0 to 127.
  151.  
  152. The value is NOT sent in real time (while you drag the slider). This is a
  153. limitation of MUI's numericbutton class. The value is sent to the synth
  154. ONLY when you release it AND if the value has changed. That is, if you just
  155. press it and release it, without dragging, no value is sent out to the
  156. synth.
  157.  
  158. The graphical display:
  159. ~~~~~~~~~~~~~~~~~~~~~~
  160. It is not implemented, yet. I temporarily removed it. It will appear on the
  161. first (Master) page.
  162.  
  163. The receive lamps:
  164. ~~~~~~~~~~~~~~~~~~
  165. They are in the Controllers section of the Part page. These are simple
  166. switches to enable/disable the reception of various midi messages on the
  167. current part.
  168.  
  169. The Instrument List:
  170. ~~~~~~~~~~~~~~~~~~~~
  171. If you press the PopUp button on the right of the Instrument Name displayer
  172. in the Part page the Instrument List pops up. Here you can select
  173. instruments. One thing you should know that you can change Banks holding the
  174. right button! A small menu pops up showing the possible Instrument Types
  175. (Ensemble, Brass, Pipe, etc.). Select the type you want to get the list of
  176. instruments of that type. The columns of the Instrument list are: Program
  177. number, Bank number, Name of instrument, and number of elements in that
  178. instrument. After finding the desired instrument, DOUBLE CLICK on that.
  179. This way you permanently selected it. Closing the Instrument List in any
  180. other way (for example, by closing the Instrument List window or pressing the
  181. PopUp button) restores the previously selected instrument for that part.
  182.  
  183. Unfortunately, this doesn't work yet for drumkits. If you browse the
  184. different drumkits in the Instrument List and close the list, your drumnote
  185. settings WILL NOT BE RESTORED. This will be changed in the future.
  186.  
  187.  
  188.  
  189.  
  190. The Future of XGTool
  191. -----------------------------------------------------------------------------
  192.  
  193. This is the first release of the program, V0.9. The version number reflects
  194. that XGTool knows almost everything I wanted her to do. The only major thing
  195. missing is the QS300 editor. This will appear in V1.0. Until V1.0, bugfixes
  196. might appear and other improvements might be implemented.
  197.  
  198. Since I'm writing this program to satisfy my needs it is useless to ask me
  199. to modify XGTool to support your XYZ-1234 tone generator. Since I'm not a
  200. very experienced programmer it took me ages to put XGTool together. It is
  201. usually very hard to implement even my own whishes.
  202.  
  203. However, I probably will be able to deal with questions and wishes related
  204. to MU10 and DB50XG, since this latter seems to be identical to MU10 apart
  205. from the missing AD inputs.
  206.  
  207. If you have any suggestions for improvement you are welcomed to write me an
  208. e-mail. See my address below.
  209.  
  210. If there is something you don't like in XGTool tell me! It can happen that I
  211. agree with you and I change XGTool.
  212.  
  213. You can help improving XGTool!
  214. - I intended to imitate the dial gadgets of XGEdit95, but didn't get the time
  215.   to do it. If you can program MUI and if you are willing to do it, I can
  216.   supply you with graphics and some small program-parts in C which are ready.
  217. - If you have a registered MUI you can make a MUI settings imitating XGEdit95
  218.   If you made one, please send me so I can distribute it together with XGTool
  219.   for the benefit of other users.
  220.  
  221. Other ideas which might get implemented in the future:
  222. - A Tool for Bars&Pipes which sends information about outgoing XG settings
  223.   to XGTool while a song is played. This way you can "rip" a MIDI file's
  224.   XG settings. I do not plan support for MIDI file reading like XGEdit95
  225.   because I know little about MIDI file formats.
  226.  
  227. Already implemented in XGTool but deactivated because not ready:
  228. - Editing of User Voices (QS300). It is very preliminary, yet.
  229. - A graphical display to edit certain parameters, like in XGEdit95.
  230.  
  231.  
  232.  
  233.  
  234. Load and Save, File Format
  235. -----------------------------------------------------------------------------
  236.  
  237. Recently I reverse engineered the file format of XGEdit95 and implemented
  238. load/save routines for that. At the beginning XGTool used a custom IFF file
  239. format to save settings. Now the fileformat of XGTool is identical to the
  240. .XGE files of XGEdit. This way the big library of .XGE files will be
  241. available to Amigans, too!
  242.  
  243. The name of the last file you worked with (loaded or saved) can be seen in
  244. the titlebar.
  245.  
  246. Some remarks:
  247. For an MU10 user some of the data in an .XGE file is superfluous:
  248. - Multi EQ settings
  249. - Insertion effects settings
  250. - MultiPart settings for channels 17-32
  251. - Second ADPart settings
  252. - Settings of Drumsets 3-4
  253.  
  254. To write a correct .XGE file, XGTool fills up these parts in the following
  255. manner:
  256.  
  257. - MultiEQ and Insertions: Defaults are written
  258. - MultiPart 17-32: Defaults are written
  259. - Second AD Part: Defaults are written
  260. - Drumsets 3-4: Same as Drumsets 1-2
  261.  
  262. I have not tried what happens when you load an .XGE file prepared for a
  263. higher spec. synth (e.g. Yamaha MU80). These files can contain effect
  264. settings and other settings which are invalid on an MU10 (Distortion or
  265. Aural Exciter effects missing from MU10). Be careful with these files.
  266.  
  267. The directory from which XGTool tries to load a file can be set with the
  268. XGTOOLDIR environment variable. If there is no such variable, the default
  269. directory is the current directory, and the last directory you used for
  270. load/save is stored at program shutdown in the XGTOOLDIR environment
  271. variable. You can set this with the standard AmigaDOS command:
  272.  
  273. setenv XGTOOLDIR "System:MyXGToolFiles"
  274.  
  275.  
  276.  
  277.  
  278. Registration, why?
  279. -----------------------------------------------------------------------------
  280.  
  281. I do not ask for money from XGTool users but I would like to know how many
  282. people use my program. It helps me to decide whether it worths to release
  283. XGTool to the public (thus doing extra work writing the documentation, etc.)
  284. or not.
  285.  
  286. In the "unregistered" version saving is disabled. You can get a fully working
  287. version by sending me and e-mail stating that you are using XGTool, and would
  288. like to use the save function. In return I will send you a patch file (.pch)
  289. for XGTool together with instructions which contains the code for saving.
  290.  
  291. The only information you have to send is your e-mail address where the patch
  292. should be sent. However, I'm very interested in what kind of tone generator,
  293. what Amiga model, etc. you are using. I will be happy if you tell me about
  294. those things but it is NOT necessary for registration.
  295.  
  296. Registered users will automatically get the new versions with saving enabled.
  297.  
  298. Registered user's e-mail address or other information will not be given to
  299. third parties, unless the user agrees that it can be done.
  300.  
  301.  
  302.  
  303.  
  304. Known bugs
  305. -----------------------------------------------------------------------------
  306.  
  307. The following is a bug in Bars&Pipes:
  308.  
  309. When you stop and restart a song in Bars&Pipes, some of your edits will be
  310. lost, because B&P sends those Program Change and Controller messages which
  311. are at the start of a Track when a song is stopped and restarted or when you
  312. rewind a song while it is playing. So it is better to erase all settings from
  313. B&P and leave the job of handling settings to XGTool.
  314.  
  315.  
  316.  
  317.  
  318. How to Reach the Author
  319. -----------------------------------------------------------------------------
  320.  
  321. My name is Csaba Molnár and my e-mail address is:
  322. mc311@ural2.hszk.bme.hu
  323. It is valid until June 1999. After that try mocsa@k2.jozsef.kando.hu, but
  324. it is not guaranteed that it will work. If it doesn't work, look for a new
  325. XGTool version on the Internet. That will contain my new address.
  326.  
  327. New versions are likely to appear
  328. - on the XGTool homepage:
  329.   http://ural2.hszk.bme.hu/~mc311/xgtool/XGTool.html
  330. - on Aminet
  331.   ftp://uk.aminet.net/aminet/mus/midi/XGTool.lha
  332.   (and on Aminet mirrors)
  333. - On Michael's XG pages:
  334.   http://xgmidi.wtal.de/
  335.